home *** CD-ROM | disk | FTP | other *** search
/ Merciful 5 / Merciful - Disc 5.iso / software / h / hypertextdatav40.12cr.lha / HTDS / Docs / HTDS.hguide < prev    next >
Encoding:
Amiga HyperGuide  |  1997-04-05  |  31.7 KB  |  726 lines

  1. @hyperguide HTDS.hguide
  2. @$VER: HTDS.hguide 40.9 (30.03.97)
  3. @macro m_prg "@{b}HyperText-DataType-System@{ub}"
  4. @macro m_welcome "@{subtitlefont}Welcome to the @{m_prg} (@{m_htds}) for AmigaOS 3.x and above.@{deffont}@{line}@{line}"
  5. @include htds.hgm
  6.  
  7. @node main "HyperText-Dataype-System (HTDS) Documentation"
  8. @next hypertext.hguide/main
  9.  
  10. @{jcenter}@{m_title}@{m_copyright}@{m_welcome}@{jleft}
  11.  
  12. @{settabs 30}
  13. @{m_sec Menu}
  14. @{m_menuitem}@{" Whats new ? "       link News}
  15.  
  16.  
  17. @{m_menuitem}@{" Copyright "         link Copyright            }@{m_menuinfo "legal stuff"}
  18. @{m_menuitem}@{" Author "            link SR.hguide/main       }@{m_menuinfo "about the Author"}
  19. @{m_menuitem}@{" Registration "      link Registration         }@{m_menuinfo "It's Shareware !!!"}
  20. @{m_menuitem}@{" Internet "          link Internet             }@{m_menuinfo "where to get updates and actual information"}
  21.  
  22. @{m_menuitem}@{" Introduction "      link Introduction         }@{m_menuinfo "What is @{m_htds} ?"}
  23. @{m_menuitem}@{" Features "          link Features             }@{m_menuinfo "Overview of features"}
  24. @{m_menuitem}@{" Configuration "     link Configuration        }@{m_menuinfo "adapt to your needs"}
  25. @{m_menuitem}@{" Base Datatype "     link hypertext.hguide/main}@{m_menuinfo "The HyperText Datatype"}
  26. @{m_menuitem}@{" Sub Datatypes "     link SubDataTypes         }@{m_menuinfo "available Sub Datatypes"}
  27. @{m_menuitem}@{" Embedding of Objects " link EmbeddingObjects  }@{m_menuinfo "How objects (pics) are embedded"}
  28. @{m_menuitem}@{" Export function "   link Exports              }@{m_menuinfo "Generate various formats like HTML,HyperGuide"}
  29. @{m_menuitem}@{" Datatypes Library"  link DataTypesLibrary     }@{m_menuinfo "some workarounds"}
  30. @{m_menuitem}@{" Locale support "    link Locale               }@{m_menuinfo "from Amiga Translation Organization"}
  31. @{m_menuitem}@{" Known Bugs "        link KnownBugs            }@{m_menuinfo "there are some :("}
  32. @{m_menuitem}@{" FAQ "               link FAQ.hguide/main      }@{m_menuinfo "Frequently Asked Questions"}
  33. @{m_menuitem}@{" Software Developer Kit " link SDK             }@{m_menuinfo "How to program @{m_htds}"}
  34. @{m_menuitem}@{" Thanks "            link Thanks               }@{m_menuinfo "I like to ..."}
  35. @{m_menuitem}@{" Third Party stuff " link ThirdParty           }@{m_menuinfo "Things I used"}
  36.  
  37. @{m_menuitem}@{" ToDo List "         link ToDo                 }@{m_menuinfo "What should be done ..."}
  38. @{m_menuitem}@{" Revision History "  link HTDS.Rev/main        }@{m_menuinfo "Implementation details"}
  39. @{m_endsec}
  40. @{cleartabs}
  41.  
  42. @endnode
  43. @node News "HTDS/Whats new ?"
  44. @{m_sec "Whats new ?"}
  45. @{itemize}
  46. @{m_sub "V40.10"}
  47. @{item}directory.datatype supports now assigns and volumes with my new @{m_sample "Root:"} handler. See @{"Config" link directory.hguide/Configuration}.
  48.  
  49. @{m_sub "V40.9"}
  50.  
  51. @{item}@{"View Source" link /ARexx/ViewSource.rexx/main} rexx script
  52. @{item}new @{"GETATTR" link hypertext.hguide/ARexxIFace_GETATTR} fields
  53. @{item}new @{"SETATTR" link hypertext.hguide/ARexxIFace_SETATTR} rexx command
  54. @{item}@{"Search XRef" link /ARexx/SearchXRef.rexx/main} rexx script
  55. @{item}background pictures in @{" HTML " link html.hguide/Tags} and @{" HyperGuide " link hyperguide.hguide/Cmds_Background}
  56. @{item}default backgrounds for all hypertext objects. See hypertext.datatype @{" Config " link hypertext.hguide/Configuration}
  57. @{item}@{"@{fgrgb ...} and @{bgrgb ...}" link hyperguide.hguide/ATTRS_TEXTCOLOR} attributes uses @{"color expressions" link hypertext.hguide/ColorExpressions}
  58. @{item}@{"node indexing" link hypertext.hguide/NodeIndexing} added
  59. @{item}@{hyperguide} supports now @{"labels" link hyperguide.hguide/ATTRS_LINKS} within a node to goto
  60. @{item}New subdatatype : @{"productinfo.datatype" link productinfo.hguide/main}
  61.  
  62. @{m_sub "V40.8"}
  63.  
  64. @{item}Brand new @{"html.datatype" link html.hguide/main}
  65. @{item}@{hyperguide} now supports @{"lists" link hyperguide.hguide/ATTRS_LISTS}
  66.  
  67. @{m_sub "V40.7"}
  68.  
  69. @{item}search @{"requester" Link hypertext.hguide/UserIFace_SearchRequester} and @{"ARexx command" link hypertext.hguide/ARexxIFace_SEARCH}. @{m_regonly}
  70. @{item}@{"RX" link hypertext.hguide/ARexxIFace_RX} ARexx command. @{m_regonly}
  71. @{item}@{"FLUSH" link hypertext.hguide/ARexxIFace_FLUSH} ARexx command.
  72. @{item}@{"EXPORT" link hypertext.hguide/ARexxIFace_EXPORT} ARexx command.
  73. @{item}@{"NEXTINTERNAL" link hypertext.hguide/ARexxIFace_NEXTINTERNAL} ARexx command.
  74. @{item}html.export class
  75. @{item}@{"HyperGuide2HTML.rexx" link /ARexx/HyperGuide2HTML.rexx/main} script
  76. @{item}HyperText documents can now be printed.
  77. @{item}The @{"navigator panel" link hyperguide.hguide/UserIFace_Navigator} is now configureable. @{m_regonly}
  78. Width of each button changes now according to the window width.
  79. @{item}@{m_htds} based ASCII datatype for normal ascii texts.
  80. @{item}new HyperGuide command : @{"@depth" link hyperguide.hguide/Cmds_Prefs}
  81. @{item}changed \@{deffont} to \@{stdfont} and added deffont macro.
  82.  
  83. @{m_sub "V40.6"}
  84.  
  85. @{item}mark lines and use the selected area for clipboard or save function. @{m_regonly}
  86. @{item}Keyfile introduced
  87. @{item}@{m_htds} keyfile is also used for my upcoming MultiView replacement : @{m_high UniView}, @{m_high dtwindow.class}
  88. @{item}@{"License" link Registration} changed
  89. @{item}@{" FAQ " link FAQ.hguide/main} started
  90. @{enditemize}
  91. @{m_endsec}
  92. @endnode
  93. @node Copyright "HTDS/Copyright"
  94.  
  95. @{m_sec Copyright}
  96. The @{m_prg}, and all files included in this distribution are, unless
  97. otherwise noted,
  98. @{line}   @{m_high "Copyright © 1995-1997 by Stefan Ruppert. All Rights Reserved."}
  99. @{m_endsec}
  100.  
  101. @{m_sec Disclaimer}
  102. No guarantee of any kind is given that the programs described in this document
  103. are 100% reliable. You are using this material at your own risk. The author takes
  104. no responsibility for any damage which is caused by using these programs/datatypes.
  105. @{m_endsec}
  106.  
  107. @{m_sec License}
  108. This license does not apply to parts of the distribution not covered by the
  109. @{m_prg} copyright. For the license of these parts, refer to the respective
  110. documentation. See @{" Third Party stuff " link ThirdParty}.
  111. This license is for non commercial usage only. A commercial license, including
  112. a product license, have to be arranged with me.
  113.  
  114.  
  115. @{fg highlight}From version 40.6 of @{m_htds} you can use the unregistered version without
  116. any time limit. But all new features, like converting of HyperText documents from and
  117. to various formats, are in future only available for registered users. See Limitations
  118. section for the current disabled features of the unregistered version.@{fg text}
  119. @{m_endsec}
  120.  
  121. @{m_sec "Product License"}
  122. A product license allows the usage of the @{m_htds} for one product for any user.
  123. This is intended for developers and companies, who wants to use the @{m_htds} for
  124. their documentation and online help. So you can get a license for your product
  125. from me, which gives any user the permission to use the full @{m_htds} for this
  126. product.
  127. @{m_endsec}
  128.  
  129. @{m_sec Distribution}
  130. Permission is hereby granted to distribute the program's archive containing
  131. the executable's and documentation for non-commercial purposes as long as the
  132. archive and its contents are not modified in any way.@{line}
  133.  
  134. It is strictly forbidden to include this archive in any kind of software collection
  135. except the Fish Amiga-Library, AmiNet-FileServer, Meating-Pearls CD's or BBS
  136. fileareas or by a explict permission from the @{"author" link SR.hguide/main} !
  137. @{m_endsec}
  138.  
  139. @{m_sec "See Also"}
  140. @{" Contact " link SR.hguide/Addresses}, @{" Registration " Link Registration},
  141. @{" Limitations " link Registration#Limitations}
  142. @{m_endsec}
  143.  
  144. @endnode
  145. @node Registration "HTDS/Registration"
  146.  
  147. @{m_sec Shareware}
  148. The @{m_prg} is not for free. In the last two years I worked
  149. in the datatypes area and I released a couple of datatypes freely.
  150. With this experience in programming datatypes, I started in march
  151. of 1995 a replacement for the text.datatype. Now after some interrupts
  152. it's a hypertext.datatype with many until yet not known @{"features" link Features}.
  153. Because I wanted to make a new documentation standard on the Amiga,
  154. I asked Amiga Technologies, if they are interested in such a
  155. hypertext.datatype base class. But they didn't want it! So it's up to
  156. you to make a new standard.
  157. @{m_endsec}
  158.  
  159. @{m_sec License}
  160. This license does not apply to parts of the distribution not covered by the
  161. @{m_prg} copyright. For the license of these parts, refer to the respective
  162. documentation. See @{" Third Party stuff " link ThirdParty}.
  163. This license is for non commercial usage only. A commercial license, including
  164. a product license, have to be arranged with me.
  165.  
  166.  
  167. @{fg highlight}From version 40.6 of @{m_htds} you can use the unregistered version without
  168. any time limit. But all new features, like converting of HyperText documents from and
  169. to various formats, are in future only available for registered users. See Limitations
  170. section for the current disabled features of the unregistered version.@{fg text}
  171. @{m_endsec}
  172.  
  173. @{m_sec "Product License"}
  174. A product license allows the usage of the @{m_htds} for one product for any user.
  175. This is intended for developers and companies, who wants to use the @{m_htds} for
  176. their documentation and online help. So you can get a license for your product
  177. from me, which gives any user the permission to use the full @{m_htds} for this
  178. product.
  179. @{m_endsec}
  180.  
  181. @{m_sec Fee}
  182. Please support it by paying the ShareWare fee in Deutsche Mark (DM), US Dollar
  183. (USD) or equivalent in other currency (DM and USD are prefered).
  184. See the table below for group registering. But contact me before ordering a
  185. group registration. There are some things to discuss before.@{line}
  186. @{m_bold Note:} @{fg highlight}There will be never a update or upgrade fee,
  187. so paying once, you get the license for the whole life !@{fg text}@{line}
  188.  
  189. @{m_sub "ShareWare Fee List"}
  190. @{settabs 20 40 60}@{code}
  191. @{b}Copies@{tab}Price for each@{ub}@{separator}
  192. 1  @{tab}@{m_high "40 DM"}@{tab}@{m_high "30 USD"}
  193. 2-5@{tab}@{m_high "30 DM"}@{tab}@{m_high "20 USD"}
  194. 6-9@{tab}@{m_high "25 DM"}@{tab}@{m_high "16 USD"}
  195. 10 or more@{tab}@{m_high "20 DM"}@{tab}@{m_high "12 USD"}
  196. @{cleartabs}@{body}
  197.  
  198. If you are also a Shareware author send me a mail. Perhaps I like
  199. your program and so we can exchange our programs.
  200.  
  201. @{b}If nobody pay's the fee, I will only release some bug fixes.
  202. But I will not add new features or requesters.
  203.  
  204. As of now version 40.5 is released about 4 month and I have only three registrations
  205. with money and one Shareware exchange. So I decided to make a keyfile. Any new
  206. feature will only be functional with this keyfile.@{ub}
  207. @{m_endsec}
  208.  
  209. @{m_sec "How to pay"}
  210. You can use the following bank account to transfer the money :
  211.  
  212. @{code}@{fg highlight}
  213. Account owner: Stefan Ruppert
  214. Bank name    : Nassauische Sparkasse Flörsheim, Germany
  215. Bank code    : 510 500 15
  216. Bank account : 208 011 537
  217. @{body}@{fg text}@{line}
  218.  
  219. Or send me the fee to :@{line}
  220.  
  221. @{fg highlight}@{m_address}@{fg text}@{line}
  222.  
  223. Don't forget the keyword "@{m_prg}" and your EMail (prefered) or postal
  224. address, so that I can send you your keyfile !
  225. Please send me your pgp key, so you get the keyfile quickest.
  226. @{m_endsec}
  227.  
  228. @{label Limitations}@{m_sec Limitations}
  229. The following functions are only available in the registered version :
  230. @{itemize}
  231. @{item}the number of opened html documents at one time is restricted to five in the unregistered version
  232. @{item}search @{"requester" link hypertext.hguide/UserIFace_SearchRequester} and @{"ARexx command" link hypertext.hguide/ARexxIFace_SEARCH}
  233. @{item}@{"RX" link hypertext.hguide/ARexxIFace_RX} ARexx command
  234. @{item}@{"EXPORT" link hypertext.hguide/ARexxIFace_EXPORT} ARexx command
  235. @{item}configuration of the @{"navigator buttons" link hypertext.hguide/UserIFace_Navigator}
  236. @{item}mark lines
  237. @{item}clear selected area
  238. @{enditemize}
  239. @{m_endsec}
  240. @{m_sec "See Also"}
  241. @{" Copyright " link Copyright}, @{" Contact " link SR.hguide/main}
  242. @{m_endsec}
  243. @endnode
  244. @node Internet "HTDS/Internet"
  245.  
  246. @{m_sec "Internet resources"}
  247. To get actual information about @{m_htds} and the latest versions of the datatypes,
  248. you can use the following Internet resources :
  249.  
  250. @{m_sub "WWW:"}
  251. @{itemize}
  252. @{item}@{http_addr "http://home.pages.de/~Ruppert/amiga/HTDS.html"}
  253. @{item}@{http_addr "http://home.pages.de/~Ruppert/amiga/HTDS/HTDS.lha"}
  254. @{item}@{http_addr "http://home.pages.de/~Ruppert/amiga/HTDS/HTDS_020.lha"}
  255. @{item}@{http_addr "http://home.pages.de/~Ruppert/amiga/HTDS/HTDS_030.lha"}
  256. @{item}@{http_addr "http://home.pages.de/~Ruppert/amiga/HTDS/HTDS_040.lha"}
  257. @{item}@{http_addr "http://home.pages.de/~Ruppert/amiga/HTDS/HTDS_060.lha"}
  258. @{item}@{http_addr "http://home.pages.de/~Ruppert/amiga/HTDS/HTDS_SDK.lha"}
  259. @{enditemize}
  260. @{m_sub "Mailing List:"}@{line}@{line}
  261. Send a subscribe mail to @{mailto_addr "majordomo@thule.no"} with no subject
  262. and message body: @{m_high "subscribe <your email address>"}.@{line}
  263. To use the list just send mails to @{mailto_addr "htds@thule.no"}.@{line}
  264. This mailing list is a offer from @{http "Petter Nilsen" "http://www.thule.no/~pettern/"}. Thanks!
  265.  
  266. @{m_sub "EMails:"}@{line}@{line}
  267. Recently I installed procmail for my email account. Please send now bug reports with the
  268. supplied form to one of the following email addresses with subject @{m_high "HTDS-Bugs"}.
  269. Ideas with @{m_high "HTDS-Ideas"} subject and registrations with subject @{m_high "HTDS-Reg"}.
  270. @{itemize}
  271. @{item}@{mailto_addr "ruppert@goofy.zdv.uni-mainz.de"}
  272. @{item}@{mailto_addr "ruppert@informatik.fh-wiesbaden.de"}
  273. @{item}@{mailto_addr "Stefan.Ruppert@informatik.fh-wiesbaden.de"}
  274. @{item}@{mailto_addr "ruppert@amigaworld.com"}
  275. @{enditemize}
  276. @{m_sub Aminet:}
  277. @{itemize}
  278. @{item}@{aminet_addr "util/dtype/HTDS.lha"}
  279. @{item}@{aminet_addr "util/dtype/HTDS_020.lha"}
  280. @{item}@{aminet_addr "util/dtype/HTDS_030.lha"}
  281. @{item}@{aminet_addr "util/dtype/HTDS_040.lha"}
  282. @{item}@{aminet_addr "util/dtype/HTDS_060.lha"}
  283. @{item}@{aminet_addr "util/dtype/HTDS_SDK.lha"}@{body}
  284. @{enditemize}
  285. @{m_sub News:}@{line}@{line}
  286. If you want to discuss general things about programming and design of datatypes/@{m_htds}
  287. comp.sys.amiga.programmer is a good place.
  288. @{m_endsec}
  289. @endnode
  290.  
  291. @node Introduction "HTDS/Introduction"
  292. @{m_sec Introduction}
  293. The reasons of writing @{m_htds} was first to replace the existing text.datatype.
  294. The include file of the text.datatype inspired me to write a datatype, which is
  295. able to embed any other datatype object. After some experiments with the existing
  296. text.datatype I decided to write a replacement. During the development of this
  297. replacement datatype, I decided to drop the compatibility for the text.datatype
  298. and write a complete new base datatype for hypertext formats.
  299.  
  300.  
  301. Now the @{m_prg} provides features, which currently only available Web-Browsers
  302. offers the Amiga user. But as all Web-Browsers they are normal applications,
  303. which have at least a ARexx port to control the behaviour of the application.
  304. Now with the @{m_htds} it's possible to intergrate for example a Web-Browser in
  305. your own application or `Webbing' around with MultiView.@{line}
  306. Because the @{m_htds} based on the Datatypes/BOOPSI concept of the AmigaOS 3.0 or
  307. newer, it's possible to derive @{"new Datatypes" link SubDataTypes} from the
  308. @{"base Datatype" link hypertext.hguide/main}. So the wide range of different
  309. text and hypertext formats are easy to implement. And hopefully in future the
  310. Amiga supports text/hypertext formats as much as current picture formats. This
  311. would make the Amiga a little bit more unique and uptodate.
  312. @{m_endsec}
  313.  
  314. @{m_sec "Requirements"}
  315. You need at least :
  316. @{itemize}
  317. @{item}AmigaOS 3.0 (V39) or newer
  318. @{item}At least 2Mb of RAM
  319. @{item}Hard drive
  320. @{enditemize}
  321. @{m_endsec}
  322. @{m_sec "See Also"}
  323. @{" Features " link Features}, @{" ToDo List " link ToDo},
  324. @{" History " link HTDS.Rev/main}
  325. @{m_endsec}
  326.  
  327. @endnode
  328. @node Features "HTDS/Features"
  329.  
  330. @{m_sec "Short overview of the features HTDS provides"}
  331. @{itemize}
  332. @{item}base datatype class for HyperText: @{"hypertext.datatype" link hypertext.hguide/main}
  333. @{item}@{"embedding" link EmbeddingObjects} of other DataTypes objects
  334. @{item}@{"basic" link hypertext.hguide/CommonAttrs} HyperGuide attributes for any subdatatype
  335. @{item}asyncron rendering (not in input task)
  336. @{item}multiple fonts
  337. @{item}links to other DataTypes objects
  338. @{item}links to programs and ARexx-scripts
  339. @{item}line separator like HTML <hr>
  340. @{item}justification left,center,right
  341. @{item}paragraphs support
  342. @{item}tabulator support
  343. @{item}own @{"ARexx port" link hypertext.hguide/ARexxIFace}
  344. @{item}@{"navigator buttons" link hypertext.hguide/UserIFace_Navigator} like AmigaGuide
  345. @{item}additional buttons 'Forward', @{"Search" link hypertext.hguide/UserIFace_SearchRequester} and @{"About" link hypertext.hguide/UserIFace_AboutRequester}
  346. @{item}@{"global" link HTDS_TOC.hguide} table of contents
  347. @{item}@{"locale" link Locale} support from ATO.
  348. @{item}mark lines @{m_regonly}
  349. @{item}a defined API
  350. @{item}example subclass with full source code (@{"SDK" link SDK})
  351. @{item}print support @{m_new 40.7}
  352. @{item}@{"search" link hypertext.hguide/UserIFace_SearchRequester} support @{m_new 40.7} @{m_regonly}
  353.  
  354. @{m_sub SubDataTypes}
  355. @{item}@{"hyperguide.datatype" link hyperguide.hguide/main} AmigaGuide compatible
  356. @{item}@{"html.datatype " link html.hguide/main}
  357. @{item}@{"htdsascii.datatype" link ASCIIDT} replaces the ascii.datatype
  358. @{item}@{"directory.datatype" link directory.hguide/main} to browse through the FileSystem
  359. or get advantage of pseudo FileSystems like Proc: or Ftp:
  360. @{item}@{"man.datatype" link man.hguide/main} browse for example gcc, unix manual pages
  361. @{item}@{"productinfo.datatype" link productinfo.hguide/main} for Product-Info files
  362.  
  363. @{m_sub "SubDataTypes from other authors"}
  364. @{item}exe.datatype from Swen Stullich
  365. @{enditemize}
  366. @{m_endsec}
  367.  
  368. @{m_sec "See Also"}
  369. @{" ToDo List " link ToDo}, @{" User Interface " link hypertext.hguide/UserIFace},
  370. @{" HyperGuide Attributes " link hyperguide.hguide/Attrs}
  371. @{m_endsec}
  372. @endnode
  373. @node Configuration "HTDS/Configuration"
  374.  
  375. @{m_sec Configuration}
  376. As the recommended standard for datatypes, each Datatype should provide a
  377. preference file, that is named @{m_file "<datatypename>.prefs"} and searched first
  378. in the @{m_file "PROGDIR:Prefs/DataTypes"} and then in @{m_file "Env:DataTypes"}
  379. directory.
  380.  
  381. The format of this preference file isn't defined, but most of the Datatypes uses
  382. ASCII files, which are parsed using the @{"dos.library/ReadArgs()" link dos/ReadArgs()}
  383. function. This format is used for all @{m_htds} datatypes.
  384.  
  385. The following links point to the configuration documentation of the
  386. appropriate Datatype :
  387.  
  388. @{itemize}
  389. @{item}@{" hypertext.datatype "   link hypertext.hguide/Configuration}
  390. @{line}
  391. @{item}@{" hyperguide.datatype "  link hyperguide.hguide/Configuration}
  392. @{item}@{" html.datatype "        link html.hguide/Configuration}
  393. @{item}@{" directory.datatype "   link directory.hguide/Configuration}
  394. @{item}@{" man.datatype "         link man.hguide/Configuration}
  395. @{item}@{" productinfo.datatype " link productinfo.hguide/Configuration}
  396. @{enditemize}
  397. @{m_endsec}
  398. @endnode
  399. @node EmbeddingObjects "HTDS/Embedding of DataTypes objects"
  400. @{m_sec "Embedding of DataTypes objects"}
  401. The most exciting feature within @{m_prg} is, that possibly all other
  402. files/objects can be embedded within a document. Requirement for this is,
  403. that the appropriate DataType supports the DTM_DRAW method. But currently
  404. only the picture.datatype V42 using my picdtpatch program, and the
  405. picture.datatype V43 by Ralph Schmidt supports the DTM_DRAW method. But this
  406. seems to be broken, please use the picdtpatch instead. I will contact Ralph.
  407. In future the hypertext.datatype itself will support that method, so
  408. that is would be possible to embed a HyperText object within a HyperText
  409. object.@{line}
  410. For example to embed a directory listing using the @{"directory.datatype" link directory.hguide/main}
  411. within a @{hyperguide} document.@{line}
  412. But with this possiblity you must take care when writing HyperText
  413. documents to not recursively embed a object.
  414. @{m_endsec}
  415.  
  416. @{m_sec "Datatypes, which supports DTM_DRAW"}
  417. @{itemize}
  418. @{item} picture.datatype V42 (using picdtpatch)
  419. @{item} Picasso96 picture.datatype V43
  420. @{item} Currently broken: picture.datatype V43 (Ralph Schmidt)
  421. @{enditemize}
  422. @{m_endsec}
  423.  
  424. @{m_sec "See Also"}
  425. @{" HyperGuide: @{object ...} " link hyperguide.hguide/ATTRS_MISC},
  426. @{" PicDTPatch " link picdtpatch.doc/main}
  427. @{m_endsec}
  428. @endnode
  429. @node Exports "HTDS/Export function"
  430. @{m_sec "Export function"}
  431. From version 40.7 @{m_htds} supports to export the current viewed hypertext
  432. page. This can be done with the @{"EXPORT" link hypertext.hguide/ARexxIFace_EXPORT} ARexx command.
  433. The following formats are currently supported :
  434. @{itemize}
  435. @{item}Ascii (intern within the hypertext.datatype)
  436. @{item}HTML (through an external html.export class)
  437. @{enditemize}
  438.  
  439. This can be exported into a file or clipboard.
  440. @{m_endsec}
  441. @{m_sec "Note"}
  442. This function is only available in the @{"registered" link Registration} version.
  443. @{m_endsec}
  444. @endnode
  445. @node DataTypesLibrary "HTDS/DataTypes Library in conjunction with HTDS"
  446. @{m_sec "DataTypes Library"}
  447. The current version of the @{m_htds} has some workarounds implemented to
  448. avoid some bugs/imcompatibilities with the DataTypes Library. This was only
  449. tested with datatypes.library 40.6, so if you have problems with the following
  450. stuff and you haven't the V40.6 version. Send @{"me" link SR.hguide/Addresses} a mail.
  451.  
  452. @{itemize}
  453. @{item}To view internal nodes of an @{hyperguide} document, it was necessary to
  454. do a NewDTObject() call with SourceType set to DTST_RAM. But this failed in the
  455. datatypesclass OM_NEW method. So I had to implement a workaround for this and its
  456. only tested with datatypes.library V40.6.
  457.  
  458. @{item}The datatypes.library provides a feature, which isn't documented : If
  459. you click in a datatypes object box and hold down the button while moving the mouse
  460. out of the datatypes object box, is does a autoscoll for that object. But the
  461. datatypes.library do not notify the application of the new position. The hypertext.datatype
  462. fixes this problem.
  463. @{enditemize}
  464. @{m_endsec}
  465. @endnode
  466. @node Locale "HTDS/Locale support"
  467. @{m_sec "Locale support"}
  468. @{m_htds} supports a various number of languages using the Amiga Translator Organisation
  469. (@{http "ATO" "http://www2.dk-online.dk/users/Ole_Friis/Trans/"}).
  470. Currently there are 12 catalogs and 8 localized help files. ATO makes the
  471. Amiga even more a little bit unique ! Thanks.
  472.  
  473.  
  474. The following people translated the catalogs and/or help files :
  475.  
  476. @{code}@{settabs 10 40 70}
  477. language@{tab}translator@{tab}proofreader@{tab}version
  478. @{separator}
  479. czech    @{tab}Ondrej Zima         @{tab}Vit Sindlar           @{tab}40.9
  480. dansk    @{tab}Thomas Petersen     @{tab}Ole Friis             @{tab}40.5
  481. deutsch  @{tab}me                  @{tab}                      @{tab}40.9
  482. english  @{tab}me                  @{tab}                      @{tab}40.9
  483. español  @{tab}Dámaso D. Estévez   @{tab}                      @{tab}40.5
  484. français @{tab}Stephane Barbaray   @{tab}                      @{tab}40.5
  485. @{tab}Francis Labrie      @{tab}                      @{tab}40.9
  486. greek    @{tab}Dimitris Panokostas @{tab}Manos Konstantiniadis @{tab}40.5
  487. italiano @{tab}Gabriele Guardi     @{tab}                      @{tab}40.9
  488. norsk    @{tab}Torbjørn Burchard   @{tab}Kjell Irgens          @{tab}40.9
  489. polski   @{tab}Adam Zalepa         @{tab}Marcin Orlowski       @{tab}40.9
  490. suomi    @{tab}Mika Lundell        @{tab}Jan Karjalainen.      @{tab}40.9
  491. svenska  @{tab}Thomas Andersson    @{tab}                      @{tab}40.5
  492. @{m_endsec}@{cleartabs}
  493. @endnode
  494. @node SubDataTypes "HTDS/SubDataTypes"
  495.  
  496. @{settabs 30}
  497. @{m_sec "SubDataTypes"}
  498. There are currently the following SubDataTypes available :
  499.  
  500.  
  501. @{m_menuitem}@{" hyperguide.datatype " link hyperguide.hguide/main}@{m_menuinfo "AmigaGuide replacement"}
  502. @{m_menuitem}@{" html.datatype "       link html.hguide/main      }@{m_menuinfo "World Wide Web"}
  503. @{m_menuitem}@{" htdsascii.datatype "  link ASCIIDT               }@{m_menuinfo "ascii.datatype replacement"}
  504. @{m_menuitem}@{" directory.datatype "  link directory.hguide/main }@{m_menuinfo "For normal directories"}
  505. @{m_menuitem}@{" man.datatype "        link man.hguide/main       }@{m_menuinfo "For unix manual pages"}
  506. @{m_menuitem}@{" productinfo.datatype " link productinfo.hguide/main}@{m_menuinfo "For ProductInfo files"}
  507.  
  508. @{m_sub "In SDK archive"}@{line}
  509. @{m_menuitem}htdemo.datatype@{m_menuinfo "Demo datatype, similar to hyperguide.datatype"}
  510. @{m_menuitem}catalog.datatype@{m_menuinfo "Example datatype to demonstrate a IFF subclass implementation"}
  511. @{m_menuitem}dirdemo.datatype@{m_menuinfo "Subclass of the directory.datatype"}
  512. @{m_endsec}
  513.  
  514. @{m_sec "See Also"}
  515. @{"ToDo List" link ToDo}
  516. @{m_endsec}
  517. @endnode
  518. @node ASCIIDT "HTDS/ASCII Datatype"
  519.  
  520. @{m_sec "htdsascii.datatype"}
  521. This datatype replaces the original ascii.datatype. Therefore you can use any feature
  522. the hypertext.datatype offers you like search ability, selecting line, etc.
  523. It supports ANSI escape sequences like the original one. But I don't know if its
  524. 100 percent compatible. So if you find a bug or some incompatibilities please let
  525. @{"me" link SR.hguide/Addresses} know.
  526. @{m_endsec}
  527. @endnode
  528. @node KnownBugs "HTDS/KnownBugs"
  529.  
  530. @{m_sec "KnownBugs"}
  531. @{itemize}
  532. @{item}If a window is in front of a hypertext datatype object, the scrolling
  533. causes some damage during rendering and it slows down. This maybe occur also, if
  534. you scroll too `fast'. Its a layers problem. Because I have to install a
  535. ClipRegion every time I have to render, and if the layer is still in LAYERREFRESH,
  536. it slows down. Everyone who knows something about such a problem, please contact
  537. @{" me " link SR.hguide/Addresses}. To undo this situation just move the window, so
  538. the layer get updated.
  539.  
  540. @{item}In some circumstances the word wrap algorithm doesn't work correctly.
  541. That is, two words can be layouted without a space between.
  542.  
  543. @{item}Not really a bug, but currently only pictures can be embedded using
  544. the picdtpatch program. See @{" Embedding of Objects " link EmbeddingObjects}.
  545.  
  546. @{item}If you use pictures as workbench backgrounds, PicDTPatch must be started
  547. between AddDataTypes and IPrefs to work correctly.
  548.  
  549. @{item}Problem with NewObtainGIRPort() patch :@{line}
  550. With such patches installed the hypertext.datatype can't render the contents
  551. of the object the first time.@{line}
  552. Currently I have a workaround embedded in the hypertext.datatype to avoid that.
  553. But please remove that patch. Here is a @{" statement " link HWObtainGIRPort/main}
  554. from Heinz Wrobel about that patch (Text included from the Amiga Developer-CD V1.1
  555. with permission from Heinz Wrobel, thanks Heinz).
  556.  
  557. @{item}There are some @{"workarounds" link DataTypesLibrary} for the datatypes.library.
  558.  
  559. @{item}The currently available binary.datatype (V39.11) and some other datatypes crashes
  560. the system, if you open a binarydt object within a hypertextdt object and you use the retrace button
  561. and then the forward button. This means, that the binary.datatype crashes the system,
  562. if you perform a forward operation to it. I want to fix this problem in future, but currently
  563. I don't know why this happens.
  564.  
  565. @{item}With the prop3d patch installed @{m_htds} crashes the system. I don't know why.
  566. @{enditemize}
  567. @{m_endsec}
  568. @{m_sec "See Also"}
  569. @{" FAQ " link FAQ.hguide/main}
  570. @{m_endsec}
  571. @endnode
  572. @node SDK "HTDS/Software Developer Kit (SDK)"
  573. @{m_sec "Software Developer Kit"}
  574. There is a SDK available : See on Aminet @{aminet_addr "util/dtype/HTDS_SDK.lha"}@{line}
  575.  
  576. @{itemize}
  577. But there is a lot to do for it :
  578. @{item}completing AutoDocs
  579. @{item}cleaning up includes
  580. @{item}defining interfaces for future compatibility
  581. @{enditemize}
  582. @{m_endsec}
  583. @endnode
  584. @node Thanks "HTDS/Thanks"
  585.  
  586. @{m_sec "Thanx have to go to"}
  587. @{itemize}
  588. @{item}Christian Buchner, for the datatypes support
  589. @{item}@{http " Martin Steigerwald " "http://home.pages.de/~helios/"}, for beta-testing
  590. @{item}Ralph Schmidt, for implementing DTM_DRAW in V43 picture.datatype
  591. @{item}Swen Stullich, for beta-testing and DTPref
  592. @{item}Andreas Mixich, for beta-testing and registering XRef
  593. @{item}@{http " Kai Hofmann " "http://www.informatik.uni-bremen.de/~i07m/"},
  594. for beta-testing and some suggestions
  595. @{item}Hartmut Goebel for his support with the html.datatype
  596. @{item}Heinz Wrobel for permission to include his @{"statement" link HWObtainGIRPort/main}
  597. about the NewObtainGIRPort() patch.
  598. @{item}Stefan Becker for @{"WBStart" link ThirdParty}
  599. @{item}Roland 'Gizzy' Mainz, for making his directory.datatype source available.
  600. I get some ideas from his source.
  601. @{item}@{http "Petter Nilsen" "http://www.thule.no/~pettern/"} for the @{m_htds} mailing
  602. list
  603. @{item}@{http "Amiga World" "http://www.amigaworld.com"} for giving me a free homepage for @{m_htds}
  604. @{item}Thomas Igracki for the permission to include his Product-Info fields documentation.
  605. @{item}Walter Dörwald for his @{aminet "LayerHook" "dev/gui/LayerHook.lha"} source.
  606. @{item}Ole Friis and all ATO members for their @{"translation" link Locale} work.
  607. @{item}and all users, especially all registered users
  608.  
  609.  
  610. @{item}Manuel Nuñez, Marius Gröger, Christoph Weyer, Roland Jung, Micheal Brühan,
  611. for discussions "about god and the world" (a german proverb : "über Gott und die Welt".
  612. I don't know, if its known in the english spooken world)@{line}
  613. @{item}@{http " Christoph Weyer " "http://www.informatik.fh-wiesbaden.de/~weyer/"}
  614. for motivating to go to the @{"Castor-Demo" link SR.hguide/Demo} in Gorleben
  615. Germany May 1996.
  616.  
  617.  
  618. @{item}Helmut Kohl for pushing my adrenaline level nearly every day.
  619. See @{" Politics " link SR.hguide/Politics}.
  620. @{enditemize}
  621. @{m_endsec}
  622. @endnode
  623. @node ThirdParty "HTDS/Third Party Stuff"
  624.  
  625. @{m_sec "Third Party Stuff"}
  626. @{m_sub "Stuff I used"}
  627. @{itemize}
  628. @{item}Compiler :@{line}
  629. All programs and datatypes in this distribution are written in C
  630. and compiled using SAS/C Version 6.57.
  631. @{item}Editors :@{line}
  632. This distribution was created using GoldED (Copyright by Dietmar Eilert) and
  633. ProgED (Copyirght by Giovanni Lambiase)
  634. @{item}GNU make (SAS/C compiled version)
  635. @{item}CatComp to create catalog files
  636. @{enditemize}
  637.  
  638. @{m_sub "SAS/C Compiler Version 6.57"}
  639.  
  640. (c) Copyright 1988-1995 SAS Institute Inc.
  641.  
  642. @{m_sub "AmigaGuide"}
  643.  
  644. AmigaGuide and AmigaGuide project icon@{line}
  645. (c) Copyright 1995-96 Escom AG, Amiga Technologies/International or Gateway 2000 ?
  646. All Rights Reserved.
  647.  
  648. @{m_sub "Installer"}
  649.  
  650. Installer and Installer project icon@{line}
  651. (c) Copyright 1995-96 Escom AG, Amiga Technologies/International or Gateway 2000 ?
  652. All Rights Reserved.
  653.  
  654. @{m_sub "MagicWB"}
  655.  
  656. (c) Copyright 1994 Martin Huttenloher. All Rights Reserved.
  657.  
  658. @{m_sub "WBStart"}
  659.  
  660. Copyright (C) 1991-96 Stefan Becker.@{line}
  661. You can get the complete archive on @{aminet_addr "util/libs/WBStart.lha"}
  662.  
  663. @{m_sub "Icons"}
  664.  
  665. Some (drawer) icons are taken from collections (mwbdrws_xxx.lha,MagicSAS1.1.lha) on AmiNet.
  666. Read the documentation from these archives.
  667.  
  668. @{m_sub "Pictures"}
  669.  
  670. Some pictures are taken from the Amiga Technologies Web-Server.@{line}
  671. (c) Copyright 1995-96 Escom AG, Amiga Technologies/International or Gateway 2000 ?
  672. All Rights Reserved.
  673. @{m_endsec}
  674.  
  675. @{m_sec "See Also"}
  676. @{" Copyright " link Copyright}
  677. @{m_endsec}
  678. @endnode
  679. @node ToDo "HTDS/ToDo List"
  680.  
  681. @{m_sec "HTDS ToDo List"}
  682. @{itemize}
  683. Here is a list of features to add to HTDS:
  684.  
  685. @{item}HTDS compatible replacement for the amigaguide.library (currently under work)
  686. @{item}Window with a list of all open documents
  687. @{item}Bookmark window
  688. @{item}implement DTM_DRAW method for the hypertext.datatype itself.
  689. @{item}implement gadgets in the document, so I can implement full HTML 3.2
  690. @{item}and more ....
  691. @{enditemize}
  692. @{itemize}
  693. hypertext.datatype improvements :
  694.  
  695. @{item}optimizations for memory usage and speed. There is much to optimize.
  696. @{item}more @{"ARexx commands" link hypertext.hguide/ARexxIFace}
  697. @{enditemize}
  698. @{itemize}
  699. hyperguide.datatype improvements :
  700.  
  701. @{item}support of lines to go to.
  702. @{item}any other idea ?
  703. @{enditemize}
  704. @{itemize}
  705. html.datatype improvements :
  706.  
  707. @{item}table support
  708. @{item}gadget support
  709. @{enditemize}
  710. @{definition}
  711. Sub DataTypes to create :
  712.  
  713. @{defterm}mail.datatype
  714. @{defdata}Read your mail with datatypes
  715. @{defterm}autodoc.datatype
  716. @{defdata}Show standard autodoc files as hypertext
  717. @{defterm}pdf.datatype
  718. @{defdata}For Adobe PDF format. If anyone of you want to write such a thing.
  719. I will give you as much help as I can.
  720. @{defterm}archive.datatype
  721. @{defdata}Datatype for archives like lha and tar using ObjArchive classes ?
  722. @{enddefinition}
  723. @{m_endsec}
  724. @endnode
  725.  
  726.